home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / catD / sleep.z / sleep
Encoding:
Text File  |  2002-10-03  |  7.1 KB  |  132 lines
  1.  
  2.  
  3.  
  4. sssslllleeeeeeeepppp((((DDDD3333))))                                                            sssslllleeeeeeeepppp((((DDDD3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _ssss_llll_eeee_eeee_pppp - suspend process execution pending occurrence of an event
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_tttt_yyyy_pppp_eeee_ssss_...._hhhh_>>>>
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_pppp_aaaa_rrrr_aaaa_mmmm_...._hhhh_>>>>
  14.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_dddd_dddd_iiii_...._hhhh_>>>>
  15.      _iiii_nnnn_tttt _ssss_llll_eeee_eeee_pppp_((((_cccc_aaaa_dddd_dddd_rrrr______tttt _e_v_e_n_t_,,,, _iiii_nnnn_tttt _f_l_a_g_s_))))_;;;;
  16.  
  17.    AAAArrrrgggguuuummmmeeeennnnttttssss
  18.      _e_v_e_n_t
  19.           Kernel address signifying an event for which the caller wishes to
  20.           wait.
  21.  
  22.      _f_l_a_g_s
  23.           Tells whether the sleep is interruptible or not.
  24.  
  25. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.      _ssss_llll_eeee_eeee_pppp suspends execution of a process to await certain events such as
  27.      reaching a known system state in hardware or software.  For instance,
  28.      when a process wants to read a device and no data are available, the
  29.      driver may need to call _ssss_llll_eeee_eeee_pppp to wait for data to become available before
  30.      returning.  This causes the kernel to suspend execution of the process
  31.      that called _ssss_llll_eeee_eeee_pppp and schedule another process.  The process that called
  32.      _ssss_llll_eeee_eeee_pppp can be resumed by a call to the _wwww_aaaa_kkkk_eeee_uuuu_pppp function with the same _e_v_e_n_t
  33.      specified as that used to call _ssss_llll_eeee_eeee_pppp.
  34.  
  35.    RRRReeeettttuuuurrrrnnnn VVVVaaaalllluuuueeeessss
  36.      _ssss_llll_eeee_eeee_pppp returns _0000 if the caller woke up because of a call to _wwww_aaaa_kkkk_eeee_uuuu_pppp.  If
  37.      the sleep is interrupted by a signal the _ssss_llll_eeee_eeee_pppp call returns a value of _1111.
  38.  
  39. UUUUSSSSAAAAGGGGEEEE
  40.    eeeevvvveeeennnntttt AAAArrrrgggguuuummmmeeeennnntttt
  41.      The address has no significance except that the same address must be
  42.      passed to _wwww_aaaa_kkkk_eeee_uuuu_pppp(D3) to resume the sleeping process.  The address used
  43.      should be the address of a kernel data structure associated with the
  44.      driver, or one of the driver's own data structures.  Use of arbitrary
  45.      addresses not associated with a private data structure can result in
  46.      conflict with other, unrelated _ssss_llll_eeee_eeee_pppp and _wwww_aaaa_kkkk_eeee_uuuu_pppp operations in the kernel.
  47.  
  48.    ffffllllaaaaggggssss AAAArrrrgggguuuummmmeeeennnntttt
  49.      The value of the _f_l_a_g_s argument determines whether the sleep may be
  50.      interrupted by signals.  If the value of _f_l_a_g_s is less than or equal to
  51.      the value of the constant _PPPP_ZZZZ_EEEE_RRRR_OOOO (defined in _ssss_yyyy_ssss_////_pppp_aaaa_rrrr_aaaa_mmmm_...._hhhh), the sleeping
  52.      process will not be awakened by a signal.  If the value of _f_l_a_g_s is
  53.      greater than _PPPP_ZZZZ_EEEE_RRRR_OOOO the process will wake up prematurely (without a call
  54.      to _wwww_aaaa_kkkk_eeee_uuuu_pppp) upon receipt of a non-ignored, non-held signal and will
  55.      normally return _1111 to the calling code.
  56.  
  57.  
  58.  
  60.  
  61.  
  62.                                                                         PPPPaaaaggggeeee 1111
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. sssslllleeeeeeeepppp((((DDDD3333))))                                                            sssslllleeeeeeeepppp((((DDDD3333))))
  70.  
  71.  
  72.  
  73.    GGGGeeeennnneeeerrrraaaallll CCCCoooonnnnssssiiiiddddeeeerrrraaaattttiiiioooonnnnssss
  74.      If a process were to sleep while it is manipulating global data inside a
  75.      critical section of driver code, it would be possible for another process
  76.      to execute base level driver code which manipulates the same data while
  77.      the first process was sleeping, resulting in data corruption.  A driver
  78.      should not sleep inside such a critical section unless it takes explicit
  79.      steps to prevent concurrent access to the data (for example, the driver
  80.      could implement its own locking protocol to protect the data).
  81.  
  82.      The value for _f_l_a_g_s should be selected based on whether or not a _wwww_aaaa_kkkk_eeee_uuuu_pppp
  83.      is certain to occur as well as the importance of the driver and of any
  84.      resources that the driver will hold after waking up.  If the driver is
  85.      holding or waiting for a critical kernel resource or is otherwise crucial
  86.      to the performance of the system, and the corresponding call to _wwww_aaaa_kkkk_eeee_uuuu_pppp is
  87.      guaranteed to happen, the driver should specify a _f_l_a_g_s argument less
  88.      than or equal to _PPPP_ZZZZ_EEEE_RRRR_OOOO.  If the driver is less performance critical or it
  89.      is possible that the _wwww_aaaa_kkkk_eeee_uuuu_pppp may not occur, the driver should specify a
  90.      _f_l_a_g_s argument greater than _PPPP_ZZZZ_EEEE_RRRR_OOOO.
  91.  
  92.      _ssss_llll_eeee_eeee_pppp will normally return a _1111 in the event of a signal, indicating that
  93.      the calling routine should perform any necessary cleanup and then return.
  94.  
  95.    LLLLeeeevvvveeeellll
  96.      Base only.
  97.  
  98.    SSSSyyyynnnncccchhhhrrrroooonnnniiiizzzzaaaattttiiiioooonnnn CCCCoooonnnnssssttttrrrraaaaiiiinnnnttttssss
  99.      Can sleep.
  100.  
  101.    NNNNooootttteeeessss
  102.      _ssss_llll_eeee_eeee_pppp and _wwww_aaaa_kkkk_eeee_uuuu_pppp are not appropriate to use in most multiprocessing
  103.      systems.  They are only useful if it is known that the driver or system
  104.      service will only ever execute on a particular processor.
  105.  
  106. RRRREEEEFFFFEEEERRRREEEENNNNCCCCEEEESSSS
  107.      _wwww_aaaa_kkkk_eeee_uuuu_pppp(D3)
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                                                                         PPPPaaaaggggeeee 2222
  129.  
  130.  
  131.  
  132.